Print output in json format when using global --json flag by vbmade2000 · Pull Request #274 · reductstore/reduct-cli

vbmade2000 · 2026-07-22T04:31:22Z

Closes #254

Please check if the PR fulfills these requirements

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
CHANGELOG.md has been updated (for bug fixes / features / docs)

What kind of change does this PR introduce?

(Bug fix, feature, docs update, ...)

What was changed?

(Describe the changes)

Related issues

(Add links to related issues)

Does this PR introduce a breaking change?

(What changes might users need to make in their application due to this PR?)

Other information:

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 · 2026-07-22T04:33:45Z

@atimin The PR is still in WIP. Let me know your thoughts on approach taken in this PR.

atimin · 2026-07-22T13:18:56Z

+        // Do not output json if the command is "cp"
+        if matches.get_flag("json") && command != "cp" {
+            let json_error = json!({
+                "status": "error",


reduct-rs sdk returns the ReductError with a status and an error message. I think we can attach it to the anyhow error and downcast here to get the status. See https://docs.rs/anyhow/latest/anyhow/trait.Context.html.

Ah I didn't know that ReductError error has status code too. I'll update the code.

atimin · 2026-07-22T13:20:54Z

Hi @vbmade2000 , I think it's a good approach but we could try to improve the error handling without breaking the interfaces.

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 · 2026-07-22T14:37:30Z

@atimin I have updated code to return status code. Let me know if it looks good to you. I'll write tests for bucket once you approve the approach.

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

atimin · 2026-07-28T09:39:10Z

+            (reduct_err.status() as i32, reduct_err.message().to_string())
+        } else {
+            // If not a ReductError, use 1 as unknown status
+            (1, err.to_string())


Hi @vbmade2000 , sorry looks like I missed your request. Yes, we can continue with the following approach but it should be -1 to be compatible with ReductStore error codes: https://github.com/reductstore/reductstore/blob/661918503a8d762f599ad1a7589c23330fb6c464/reduct_base/src/error.rs#L23

No probs. I'll keep that in mind.

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 · 2026-07-29T11:14:54Z

@atimin This one is ready for review. I don't know why the test is failing. It passes on my system.

vbmade2000 · 2026-07-29T12:24:09Z

Closed by mistake.

atimin

Hi @vbmade2000 ,

Let's add the flag into all the bucket commands not only "create". Please update the changelog file and the PR description.

Thank you!

atimin · 2026-07-31T08:49:42Z

@atimin This one is ready for review. I don't know why the test is failing. It passes on my system.

The "cargo fmt" command is failing. You can use pre-commit to run the formatting automatically.

vbmade2000 · 2026-07-31T11:25:25Z

Hi @vbmade2000 ,

Let's add the flag into all the bucket commands not only "create". Please update the changelog file and the PR description.

Thank you!

Indeed. This is just for your approval. I don't want to do rework so I move forward after I get approval from you.

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 · 2026-08-02T06:46:17Z

@atimin I think this one is ready for review. The current failure of test is I think random because I haven't touched that part. I guess it should pass once you restart the flow.

atimin

Hi @vbmade2000 , thank you for the PR.

Unfortunately, we should work on it a bit more. Please, see my comments.

The --json flag is supposed to be used in scripts and automations so must be muchine friendly first. Instead of:

{
  "bucket": {
    "name": "src",
    "quota_type": "NONE",
    "entry_count": 0,
    "quota_size": "0 B",
    "size": "0 B",
    "max_block_size": "64.0 MB",
    "blocks": 0,
    "max_block_records": 1024,
    "status": "✅ Ready",
    "provisioned": "✓"
  },
  "entries": []
}

We should send:

{
"bucket": {
"name": "src",
"quota_type": "NONE",
"entry_count": 0,
"quota_size": 0,
"size": 0,
"max_block_size": 640000000,
"blocks": 0,
"max_block_records": 1024,
"status": "READY",
"provisioned": true,
},
"entries": []
}


Actually , just  the JSON payload we receive from the backend.

Thank you!

atimin · 2026-08-03T07:42:35Z

        self.ca_cert.as_ref()
    }
+
+    pub(crate) fn json(&self) -> Option<bool> {


I don't think it makes sense to use option for a boolean flag here. We print the json output or not -- no the 3rd state.

atimin · 2026-08-03T07:43:51Z

 }

-fn print_list(ctx: &CliContext, bucket_list: BucketInfoList) {
+fn print_list(ctx: &CliContext, bucket_list: BucketInfoList, is_json: bool) {


We have the JSON flag in the context, so there is no need to add an additional parameter.

atimin · 2026-08-03T07:45:37Z

 }

-#[derive(Tabled)]
+#[derive(Deserialize, Serialize, Tabled)]


Ideally, I would like to serialize the JSON data we receive from the backend in order to decouple the API and its table representation.

atimin · 2026-08-03T07:46:04Z

 }

-fn print_full_list(ctx: &CliContext, bucket_list: BucketInfoList) {
+fn print_full_list(ctx: &CliContext, bucket_list: BucketInfoList, is_json: bool) {


We have the flag in the context already.

atimin · 2026-08-03T07:56:33Z

+        .await?;
    } else {
-        remove_entire_bucket(ctx, args, &alias_or_url, &bucket_name).await?;
+        remove_entire_bucket(ctx, args, &alias_or_url, &bucket_name, is_json).await?;


Print json when using global --json

338d55f

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

atimin reviewed Jul 22, 2026

View reviewed changes

Improvement: Return status code and message

2c38bb5

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 requested a review from atimin July 22, 2026 14:37

Update "create bucket" to use global flag

e635baa

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

Harshal875 mentioned this pull request Jul 28, 2026

Task: add --json output for lifecycle commands #257

Open

atimin reviewed Jul 28, 2026

View reviewed changes

vbmade2000 marked this pull request as ready for review July 29, 2026 08:35

Some corrections and tests

6d38d33

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 force-pushed the mvora/254-add-json-output-for-bucket-commands branch from 317ad1a to 6d38d33 Compare July 29, 2026 08:56

vbmade2000 closed this Jul 29, 2026

vbmade2000 reopened this Jul 29, 2026

atimin requested changes Jul 31, 2026

View reviewed changes

vbmade2000 added 2 commits July 31, 2026 16:55

cargo fmt

2d20584

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

Use config_path from existing context in failing UT

41e1988

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 force-pushed the mvora/254-add-json-output-for-bucket-commands branch 3 times, most recently from 4a6caa1 to bef8867 Compare July 31, 2026 16:35

Add json handling to "ls" sub-command with unit tests

c23d785

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 force-pushed the mvora/254-add-json-output-for-bucket-commands branch from bef8867 to c23d785 Compare July 31, 2026 16:43

Handle "--json" flag in "rename" command with UTs

3fa02bf

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 force-pushed the mvora/254-add-json-output-for-bucket-commands branch from a885ff2 to b21cfa4 Compare August 1, 2026 10:47

Some corrections in UTs

c59c3c2

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

vbmade2000 force-pushed the mvora/254-add-json-output-for-bucket-commands branch from b21cfa4 to c59c3c2 Compare August 1, 2026 11:30

vbmade2000 added 4 commits August 1, 2026 18:32

Handle "--json" flag in "rm" command with UTs

874a426

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

Handle "--json" flag in "update" command with UTs

3d6d42a

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

Handle "--json" flag in "show" command with UTs

3bbe885

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

Update changelog

3a5ba08

Signed-off-by: Malhar Vora <mlvora.2010@gmail.com>

atimin requested changes Aug 3, 2026

View reviewed changes

Uh oh!

Conversation

vbmade2000 commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please check if the PR fulfills these requirements

What kind of change does this PR introduce?

What was changed?

Related issues

Does this PR introduce a breaking change?

Other information:

Uh oh!

vbmade2000 commented Jul 22, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atimin commented Jul 22, 2026

Uh oh!

vbmade2000 commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vbmade2000 commented Jul 29, 2026

Uh oh!

vbmade2000 commented Jul 29, 2026

Uh oh!

atimin left a comment

Choose a reason for hiding this comment

Uh oh!

atimin commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vbmade2000 commented Jul 31, 2026

Uh oh!

vbmade2000 commented Aug 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

atimin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vbmade2000 commented Jul 22, 2026 •

edited

Loading

vbmade2000 commented Jul 22, 2026 •

edited

Loading

atimin commented Jul 31, 2026 •

edited

Loading

vbmade2000 commented Aug 2, 2026 •

edited

Loading